<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PDO_doc_cache_document</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class PDO_doc_cache_document</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Acts as a document-specific wrapper to <a href="../../PDO_doc_cache/PDO_doc_cache.html">PDO_doc_cache</a></p>
		<p class="notes">
			Located in <a class="field" href="_pdo-doc-cache.php.html">/pdo-doc-cache.php</a> (line <span class="field">1101</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../PDO_doc_cache_document/PDO_doc_cache_document_deflate.html">PDO_doc_cache_document_deflate</a></td>
					<td>
											Automatically compresses/decompresses document
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$cache_id" title="details" class="var-name">$cache_id</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$compile_id" title="details" class="var-name">$compile_id</a>
				</div>
																<div class="var-title">
					<span class="var-type">created</span>
					<a href="#$created" title="details" class="var-name">$created</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$document" title="details" class="var-name">$document</a>
				</div>
																<div class="var-title">
					<span class="var-type">integer</span>
					<a href="#$expires" title="details" class="var-name">$expires</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$filename" title="details" class="var-name">$filename</a>
				</div>
																<div class="var-title">
					<span class="var-type">PDO_doc_cache</span>
					<a href="#$PDO_doc_cache" title="details" class="var-name">$PDO_doc_cache</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																				
												<div class="method-definition">
											<span class="method-result">PDO_doc_cache_document</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../../PDO_doc_cache/PDO_doc_cache.html">PDO_doc_cache</a></span>&nbsp;<span class="var-name">$PDO_doc_cache</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$cache_id</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compile_id</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#auto_serialize_off" title="details" class="method-name">auto_serialize_off</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#auto_serialize_on" title="details" class="method-name">auto_serialize_on</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#cache" title="details" class="method-name">cache</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$document</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lifetime</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#clear_cache" title="details" class="method-name">clear_cache</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$expire_time</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#created" title="details" class="method-name">created</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#expires" title="details" class="method-name">expires</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#fetch" title="details" class="method-name">fetch</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#is_cached" title="details" class="method-name">is_cached</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_callback" title="details" class="method-name">set_callback</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$cache_callback</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fetch_callback</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$cache_id" id="$cache_id"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$cache_id</span>
						(line <span class="line-number">1114</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#method__construct">PDO_doc_cache_document::__construct()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$compile_id" id="$compile_id"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$compile_id</span>
						(line <span class="line-number">1118</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#method__construct">PDO_doc_cache_document::__construct()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$created" id="$created"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">created</span>
			<span class="var-name">$created</span>
						(line <span class="line-number">1130</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$document" id="$document"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$document</span>
						(line <span class="line-number">1122</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$expires" id="$expires"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">integer</span>
			<span class="var-name">$expires</span>
						(line <span class="line-number">1126</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$filename" id="$filename"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$filename</span>
						(line <span class="line-number">1110</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#method__construct">PDO_doc_cache_document::__construct()</a></li>
			</ul>
	
	
		
		

</div>
<a name="var$PDO_doc_cache" id="$PDO_doc_cache"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">PDO_doc_cache</span>
			<span class="var-name">$PDO_doc_cache</span>
						(line <span class="line-number">1106</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> The PDO_doc_cache instance used by the document</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#method__construct">PDO_doc_cache_document::__construct()</a></li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">1167</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#var$filename">PDO_doc_cache_document::$filename</a></li>
				<li><span class="field">uses:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#var$PDO_doc_cache">PDO_doc_cache_document::$PDO_doc_cache</a></li>
				<li><span class="field">uses:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#var$compile_id">PDO_doc_cache_document::$compile_id</a></li>
				<li><span class="field">uses:</span> <a href="../../PDO_doc_cache/PDO_doc_cache_document/PDO_doc_cache_document.html#var$cache_id">PDO_doc_cache_document::$cache_id</a></li>
				<li><span class="field">uses:</span> PDO_doc_cache::validate_compile_id)</li>
				<li><span class="field">uses:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodvalidate_filename">PDO_doc_cache::validate_filename()</a></li>
				<li><span class="field">uses:</span> PDO_doc_cache::validate_cache_id)</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">PDO_doc_cache_document</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../../PDO_doc_cache/PDO_doc_cache.html">PDO_doc_cache</a></span>&nbsp;<span class="var-name">$PDO_doc_cache</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$filename</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$cache_id</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$compile_id</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">PDO_doc_cache</span>
				<span class="var-name">$PDO_doc_cache</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filename</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$cache_id</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$compile_id</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../PDO_doc_cache_document/PDO_doc_cache_document_deflate.html#method__construct">PDO_doc_cache_document_deflate::__construct()</a>
							</li>
				</ul>
	</div>
<a name="methodauto_serialize_off" id="auto_serialize_off"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">auto_serialize_off</span> (line <span class="line-number">1149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> PDO_doc_cache::auto_serialize_off)</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			auto_serialize_off
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodauto_serialize_on" id="auto_serialize_on"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">auto_serialize_on</span> (line <span class="line-number">1142</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodauto_serialize_on">PDO_doc_cache::auto_serialize_on()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			auto_serialize_on
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodcache" id="cache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">cache</span> (line <span class="line-number">1227</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodcache">PDO_doc_cache::cache()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			cache
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$document</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$lifetime</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$document</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$lifetime</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclear_cache" id="clear_cache"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">clear_cache</span> (line <span class="line-number">1235</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodclear_cache">PDO_doc_cache::clear_cache()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clear_cache
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$expire_time</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$expire_time</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcreated" id="created"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">created</span> (line <span class="line-number">1216</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodcreated">PDO_doc_cache::created()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			created
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodexpires" id="expires"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">expires</span> (line <span class="line-number">1205</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodexpires">PDO_doc_cache::expires()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			expires
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfetch" id="fetch"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">fetch</span> (line <span class="line-number">1187</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> PDO_doc_cache::fetch)</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			fetch
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodis_cached" id="is_cached"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">is_cached</span> (line <span class="line-number">1180</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodis_cached">PDO_doc_cache::is_cached()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			is_cached
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_callback" id="set_callback"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_callback</span> (line <span class="line-number">1135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../PDO_doc_cache/PDO_doc_cache.html#methodset_callback">PDO_doc_cache::set_callback()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_callback
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$cache_callback</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$fetch_callback</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$cache_callback</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$fetch_callback</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 13 Jan 2009 23:22:04 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>